home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 21 / AACD 21.iso / AACD / Utilities / Ghostscript / src / opdef.h < prev    next >
Encoding:
C/C++ Source or Header  |  2001-01-01  |  6.1 KB  |  167 lines
  1. /* Copyright (C) 1991, 1995, 1998, 1999 Aladdin Enterprises.  All rights reserved.
  2.   
  3.   This file is part of AFPL Ghostscript.
  4.   
  5.   AFPL Ghostscript is distributed with NO WARRANTY OF ANY KIND.  No author or
  6.   distributor accepts any responsibility for the consequences of using it, or
  7.   for whether it serves any particular purpose or works at all, unless he or
  8.   she says so in writing.  Refer to the Aladdin Free Public License (the
  9.   "License") for full details.
  10.   
  11.   Every copy of AFPL Ghostscript must include a copy of the License, normally
  12.   in a plain ASCII text file named PUBLIC.  The License grants you the right
  13.   to copy, modify and redistribute AFPL Ghostscript, but only under certain
  14.   conditions described in the License.  Among other things, the License
  15.   requires that the copyright notice and this notice be preserved on all
  16.   copies.
  17. */
  18.  
  19. /*$Id: opdef.h,v 1.2 2000/09/19 19:00:47 lpd Exp $ */
  20. /* Operator definition interface for Ghostscript */
  21.  
  22. #ifndef opdef_INCLUDED
  23. #  define opdef_INCLUDED
  24.  
  25. /*
  26.  * Define the structure for initializing the operator table.  Each operator
  27.  * file zxxx.c declares an array of these as follows:
  28.  
  29.  const op_def * const zxxx_op_defs[] = {
  30.     {"1name", zname},
  31.     ...
  32.     op_def_end(iproc)
  33.  };
  34.  
  35.  * where iproc is an initialization procedure for the file, or 0.  This
  36.  * definition always appears at the END of the file, to avoid the need for
  37.  * forward declarations for all the operator procedures.  For backward
  38.  * compatibility with an older convention, we also allow (deprecated)
  39.  
  40.  BEGIN_OP_DEFS(my_defs) {
  41.     {"1name", zname},
  42.     ...
  43.  END_OP_DEFS(iproc) }
  44.  
  45.  * Operators may be stored in dictionaries other than systemdict.
  46.  * We support this with op_def entries of a special form:
  47.  
  48.  op_def_begin_dict("dictname"),
  49.  
  50.  */
  51. typedef struct {
  52.     const char *oname;
  53.     op_proc_t proc;
  54. } op_def;
  55.  
  56. #define op_def_begin_dict(dname) {dname, 0}
  57. #define op_def_begin_filter() op_def_begin_dict("filterdict")
  58. #define op_def_begin_level2() op_def_begin_dict("level2dict")
  59. #define op_def_begin_ll3() op_def_begin_dict("ll3dict")
  60. #define op_def_is_begin_dict(def) ((def)->proc == 0)
  61. #define op_def_end(iproc) {0, iproc}
  62.  
  63. /*
  64.  * NOTE: for implementation reasons, a single table of operator definitions
  65.  * is limited to 16 entries, including op_def_begin_xxx entries.  If a file
  66.  * defines more operators than this, it must split them into multiple
  67.  * tables and have multiple -oper entries in the makefile.  Currently,
  68.  * only 4 out of 85 operator files require this.
  69.  */
  70. #define OP_DEFS_LOG2_MAX_SIZE 4
  71. #define OP_DEFS_MAX_SIZE (1 << OP_DEFS_LOG2_MAX_SIZE)
  72.  
  73. /*
  74.  * Define the table of pointers to all operator definition tables.
  75.  */
  76. extern const op_def *const op_defs_all[];
  77.  
  78. /*
  79.  * Formerly, we needed to define each op_defs table as a procedure that
  80.  * returns the actual table, because of cross-segment linking restrictions
  81.  * in the 16-bit Borland C compiler for MS Windows.  This is no longer
  82.  * relevant, but for backward compatibility, we need to retain
  83.  * BEGIN/END_OP_DEFS with the same syntax.  This involves a kludge to create
  84.  * a dummy procedure to match up with a closing brace, and another kludge to
  85.  * prevent a "defined but not used" warning.
  86.  */
  87.  
  88. #define BEGIN_OP_DEFS(xx_op_defs)\
  89. const op_def xx_op_defs[] =
  90.  
  91. #define END_OP_DEFS(iproc)\
  92.     op_def_end(iproc)\
  93. };\
  94. static int op_defs_dummy(void)\
  95. {    return 1 || op_defs_dummy();    /* generates the least wasted code */
  96.  
  97. /*
  98.  * Internal operators whose names begin with %, such as continuation
  99.  * operators, do not appear in systemdict.  Ghostscript assumes
  100.  * that these operators cannot appear anywhere (in executable form)
  101.  * except on the e-stack; to maintain this invariant, the execstack
  102.  * operator converts them to literal form, and cvx refuses to convert
  103.  * them back.  As a result of this invariant, they do not need to
  104.  * push themselves back on the e-stack when executed, since the only
  105.  * place they could have come from was the e-stack.
  106.  */
  107. #define op_def_is_internal(def) ((def)->oname[1] == '%')
  108.  
  109. /*
  110.  * All operators are catalogued in a table; this is necessary because
  111.  * they must have a short packed representation for the sake of 'bind'.
  112.  * The `size' of an operator is normally its index in this table;
  113.  * however, internal operators have a `size' of 0, and their true index
  114.  * must be found by searching the table for their procedure address.
  115.  */
  116. ushort op_find_index(P1(const ref *));
  117.  
  118. #define op_index(opref)\
  119.   (r_size(opref) == 0 ? op_find_index(opref) : r_size(opref))
  120.  
  121. /*
  122.  * There are actually two kinds of operators: the real ones (t_operator),
  123.  * and ones defined by procedures (t_oparray).  The catalog for t_operators
  124.  * is (indirectly) op_defs_all, and their index is in the range
  125.  * [1..op_def_count-1].
  126.  */
  127. #define op_index_is_operator(index) ((index) < op_def_count)
  128. extern const uint op_def_count;
  129.  
  130. #define op_index_def(index)\
  131.   (&op_defs_all[(index) >> OP_DEFS_LOG2_MAX_SIZE]\
  132.     [(index) & (OP_DEFS_MAX_SIZE - 1)])
  133. #define op_num_args(opref) (op_index_def(op_index(opref))->oname[0] - '0')
  134. #define op_index_proc(index) (op_index_def(index)->proc)
  135.  
  136. /*
  137.  * There are two catalogs for t_oparrays, one global and one local.
  138.  * Operator indices for the global table are in the range
  139.  *      [op_def_count..op_def_count+op_array_global.count-1]
  140.  * Operator indices for the local table are in the range
  141.  *      [op_def_count+r_size(&op_array_global.table)..
  142.  *        op_def_count+r_size(&op_array_global.table)+op_array_local.count-1]
  143.  */
  144. typedef struct op_array_table_s {
  145.     ref table;            /* t_array */
  146.     ushort *nx_table;        /* name indices */
  147.     uint count;            /* # of occupied entries */
  148.     uint base_index;        /* operator index of first entry */
  149.     uint attrs;            /* ref attrs of ops in this table */
  150.     ref *root_p;        /* self-pointer for GC root */
  151. } op_array_table;
  152. extern op_array_table
  153.        op_array_table_global, op_array_table_local;
  154.  
  155. #define op_index_op_array_table(index)\
  156.   ((index) < op_array_table_local.base_index ?\
  157.    &op_array_table_global : &op_array_table_local)
  158.  
  159. /*
  160.  * Convert an operator index to an operator or oparray ref.
  161.  * This is only used for debugging and for 'get' from packed arrays,
  162.  * so it doesn't have to be very fast.
  163.  */
  164. void op_index_ref(P2(uint, ref *));
  165.  
  166. #endif /* opdef_INCLUDED */
  167.